<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: LDO</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__syspm__functions__ldo.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">LDO<div class="ingroups"><a class="el" href="group__group__syspm.html">SysPm        (System Power Management)</a> &raquo; <a class="el" href="group__group__syspm__functions.html">Functions</a> &raquo; <a class="el" href="group__group__syspm__functions__core__regulators.html">Core Voltage Regulation</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa583169f7b72095e98650fc30dfbcb24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#gaa583169f7b72095e98650fc30dfbcb24">Cy_SysPm_LdoSetVoltage</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaef8ba4a0ee827abcaaf62f950e69496e">cy_en_syspm_ldo_voltage_t</a> voltage)</td></tr>
<tr class="memdesc:gaa583169f7b72095e98650fc30dfbcb24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set output voltage on the core LDO regulator.  <a href="#gaa583169f7b72095e98650fc30dfbcb24">More...</a><br /></td></tr>
<tr class="separator:gaa583169f7b72095e98650fc30dfbcb24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3134f6b474d6bba15825971923349372"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga3134f6b474d6bba15825971923349372">Cy_SysPm_LdoSetMode</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gab23a08d99fea934c12e01f877c26dd80">cy_en_syspm_ldo_mode_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga3134f6b474d6bba15825971923349372"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the core LDO regulator operating mode to one of three modes.  <a href="#ga3134f6b474d6bba15825971923349372">More...</a><br /></td></tr>
<tr class="separator:ga3134f6b474d6bba15825971923349372"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d545d75711f6aa1889ec5faa871d9fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#gab23a08d99fea934c12e01f877c26dd80">cy_en_syspm_ldo_mode_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga5d545d75711f6aa1889ec5faa871d9fb">Cy_SysPm_LdoGetMode</a> (void)</td></tr>
<tr class="memdesc:ga5d545d75711f6aa1889ec5faa871d9fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current core LDO regulator operating mode.  <a href="#ga5d545d75711f6aa1889ec5faa871d9fb">More...</a><br /></td></tr>
<tr class="separator:ga5d545d75711f6aa1889ec5faa871d9fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9902e6f64bd939f234fe15612d0f1da8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga9902e6f64bd939f234fe15612d0f1da8">Cy_SysPm_LdoIsEnabled</a> (void)</td></tr>
<tr class="memdesc:ga9902e6f64bd939f234fe15612d0f1da8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current status of the core LDO regulator.  <a href="#ga9902e6f64bd939f234fe15612d0f1da8">More...</a><br /></td></tr>
<tr class="separator:ga9902e6f64bd939f234fe15612d0f1da8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00ae492b61f731af99f3f378e640e82c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga00ae492b61f731af99f3f378e640e82c">Cy_SysPm_SdrConfigure</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a> sdr, <a class="el" href="structcy__stc__syspm__sdr__params__t.html">cy_stc_syspm_sdr_params_t</a> *config)</td></tr>
<tr class="memdesc:ga00ae492b61f731af99f3f378e640e82c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the SDR(Step Down Regulator)  <a href="#ga00ae492b61f731af99f3f378e640e82c">More...</a><br /></td></tr>
<tr class="separator:ga00ae492b61f731af99f3f378e640e82c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadee6863d26fa2d5edf2631e265890aca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#gadee6863d26fa2d5edf2631e265890aca">Cy_SysPm_SdrSetVoltage</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a> sdr, <a class="el" href="group__group__syspm__data__enumerates.html#ga5b3fa93779730eb75af8b267923d68c1">cy_en_syspm_sdr_voltage_t</a> voltage)</td></tr>
<tr class="memdesc:gadee6863d26fa2d5edf2631e265890aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the SDR(Step Down Regulator) Voltage.  <a href="#gadee6863d26fa2d5edf2631e265890aca">More...</a><br /></td></tr>
<tr class="separator:gadee6863d26fa2d5edf2631e265890aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae44ed9b76b5c3d3362f4c05b981d3811"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga5b3fa93779730eb75af8b267923d68c1">cy_en_syspm_sdr_voltage_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#gae44ed9b76b5c3d3362f4c05b981d3811">Cy_SysPm_SdrGetVoltage</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a> sdr)</td></tr>
<tr class="memdesc:gae44ed9b76b5c3d3362f4c05b981d3811"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the SDR(Step Down Regulator) Voltage.  <a href="#gae44ed9b76b5c3d3362f4c05b981d3811">More...</a><br /></td></tr>
<tr class="separator:gae44ed9b76b5c3d3362f4c05b981d3811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa3fba12a46b88e6065a29d571d86b9cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#gaa3fba12a46b88e6065a29d571d86b9cd">Cy_SysPm_SdrEnable</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a> sdr, bool enable)</td></tr>
<tr class="memdesc:gaa3fba12a46b88e6065a29d571d86b9cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the SDR(Step Down Regulator)  <a href="#gaa3fba12a46b88e6065a29d571d86b9cd">More...</a><br /></td></tr>
<tr class="separator:gaa3fba12a46b88e6065a29d571d86b9cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga674c55d4039bdd8f3edadabc77d8ebea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga674c55d4039bdd8f3edadabc77d8ebea">Cy_SysPm_IsSdrEnabled</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a> sdr)</td></tr>
<tr class="memdesc:ga674c55d4039bdd8f3edadabc77d8ebea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if SDR(Step Down Regulator) is enabled or not.  <a href="#ga674c55d4039bdd8f3edadabc77d8ebea">More...</a><br /></td></tr>
<tr class="separator:ga674c55d4039bdd8f3edadabc77d8ebea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac91039d9210a0acdf5335cf839680f87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#gac91039d9210a0acdf5335cf839680f87">Cy_SysPm_HvLdoConfigure</a> (<a class="el" href="structcy__stc__syspm__hvldo__params__t.html">cy_stc_syspm_hvldo_params_t</a> *config)</td></tr>
<tr class="memdesc:gac91039d9210a0acdf5335cf839680f87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the HVLDO Regulator.  <a href="#gac91039d9210a0acdf5335cf839680f87">More...</a><br /></td></tr>
<tr class="separator:gac91039d9210a0acdf5335cf839680f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75ff19a75ee1a483fa0f5b3c50157cd4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga75ff19a75ee1a483fa0f5b3c50157cd4">Cy_SysPm_HvLdoSetVoltage</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga64b1d9370a07008a83b14bcbee4f731c">cy_en_syspm_hvldo_voltage_t</a> voltage)</td></tr>
<tr class="memdesc:ga75ff19a75ee1a483fa0f5b3c50157cd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the HVLDO Regulator Voltage.  <a href="#ga75ff19a75ee1a483fa0f5b3c50157cd4">More...</a><br /></td></tr>
<tr class="separator:ga75ff19a75ee1a483fa0f5b3c50157cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga462f8b51cd933b85d270d64fe00bdafa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga64b1d9370a07008a83b14bcbee4f731c">cy_en_syspm_hvldo_voltage_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga462f8b51cd933b85d270d64fe00bdafa">Cy_SysPm_HvLdoGetVoltage</a> (void)</td></tr>
<tr class="memdesc:ga462f8b51cd933b85d270d64fe00bdafa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the HVLDO Regulator Voltage.  <a href="#ga462f8b51cd933b85d270d64fe00bdafa">More...</a><br /></td></tr>
<tr class="separator:ga462f8b51cd933b85d270d64fe00bdafa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga25bdb2ff02fd26194f094ab7b144eaba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga25bdb2ff02fd26194f094ab7b144eaba">Cy_SysPm_HvLdoEnable</a> (bool enable)</td></tr>
<tr class="memdesc:ga25bdb2ff02fd26194f094ab7b144eaba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the HVLDO Regulator.  <a href="#ga25bdb2ff02fd26194f094ab7b144eaba">More...</a><br /></td></tr>
<tr class="separator:ga25bdb2ff02fd26194f094ab7b144eaba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga085d5c511f849d5846338f79c1e7778f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__ldo.html#ga085d5c511f849d5846338f79c1e7778f">Cy_SysPm_IsHvLdoEnabled</a> (void)</td></tr>
<tr class="memdesc:ga085d5c511f849d5846338f79c1e7778f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if HVLDO Regulator is enabled or not.  <a href="#ga085d5c511f849d5846338f79c1e7778f">More...</a><br /></td></tr>
<tr class="separator:ga085d5c511f849d5846338f79c1e7778f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa583169f7b72095e98650fc30dfbcb24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa583169f7b72095e98650fc30dfbcb24">&#9670;&nbsp;</a></span>Cy_SysPm_LdoSetVoltage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_SysPm_LdoSetVoltage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaef8ba4a0ee827abcaaf62f950e69496e">cy_en_syspm_ldo_voltage_t</a>&#160;</td>
          <td class="paramname"><em>voltage</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set output voltage on the core LDO regulator. </p>
<p>When changing from a higher voltage to a lower voltage as when the device enters system ULP mode, ensure that:</p><ul>
<li>The device maximum operating frequency for all the Clk_HF paths, peripheral, and slow clock are under the <a class="el" href="group__group__syspm.html#group_syspm_ulp_limitations">ULP Limitations</a>.</li>
<li>The total current consumption is under the <a class="el" href="group__group__syspm.html#group_syspm_ulp_limitations">ULP Limitations</a>.</li>
<li>The appropriate wait states values are set for the flash using The <a class="el" href="group__group__syslib__functions.html#ga8b897f8554957f9393f645d5ab1106c9" title="Sets the number of clock cycles the cache will wait for, before it samples data coming back from ROM...">Cy_SysLib_SetWaitStates()</a> function as explained below.</li>
</ul>
<p><b>Setting wait states values for flash</b></p>
<p>The flash access time when the core voltage is 0.9 V (nominal) is longer than at 1.1 V (nominal). Therefore, the number of the wait states must be adjusted. Use the <a class="el" href="group__group__syslib__functions.html#ga8b897f8554957f9393f645d5ab1106c9" title="Sets the number of clock cycles the cache will wait for, before it samples data coming back from ROM...">Cy_SysLib_SetWaitStates()</a> function to set the appropriate wait state values for flash.</p>
<p>To change from a higher voltage to a lower voltage 0.9 V (nominal), call the Cy_SysLib_SetWaitStates(true, hfClkFreqMz) function before changing the voltage, where hfClkFreqMz is the frequency of HfClk0 in MHz.</p>
<p>To change from a lower voltage to a higher voltage 1.1 V (nominal), calling the Cy_SysLib_SetWaitStates(false, hfClkFreqMz) function to set the wait states is optional, but can be done to improve performance. The clock frequency may now be increased up to <a class="el" href="group__group__syspm.html#group_syspm_lp_limitations">LP Limitations</a>.</p>
<dl class="section note"><dt>Note</dt><dd>1. The output is set to 0.9 V (nominal) - the system is in ULP mode and flash works for read-only operation. </dd>
<dd>
2. The output is set to 1.1 V (nominal) - the system is in LP mode and flash works for read and write operations. </dd>
<dd>
3. The actual device Vccd voltage can be different from the nominal voltage because the actual voltage value depends on conditions including the load current.</dd></dl>
<p>For more detail, refer to the <a class="el" href="group__group__syspm.html#group_syspm_switching_into_ulp">Switching the System into Ultra Low Power</a> and <a class="el" href="group__group__syspm.html#group_syspm_switching_into_lp">Switching the System into Low Power</a> sections. Refer to the <a class="el" href="group__group__syslib.html">SysLib (System Library)</a> driver for more detail about setting the wait states.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">voltage</td><td>The desired output regulator voltage. See <a class="el" href="group__group__syspm__data__enumerates.html#gaef8ba4a0ee827abcaaf62f950e69496e">cy_en_syspm_ldo_voltage_t</a> voltage</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>CY_SYSPM_SUCCESS - The voltage is set.</li>
<li>CY_SYSPM_INVALID_STATE - The voltage was not set. The voltage cannot be set because the protection context value is higher than zero (PC &gt; 0) or the device revision does not support modifying registers via syscall.</li>
<li>CY_SYSPM_CANCELED - Operation was canceled. Call the function again until the function returns CY_SYSPM_SUCCESS. See <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>. For the PSoC 64 devices there are possible situations when function returns the PRA error status code. This is because for PSoC 64 devices the function uses the PRA driver to change the protected registers. Refer to <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> for more details.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A, CAT1B(PSOC C3) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to increase the core supply voltage  */</span></div><div class="line">    <a class="code" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> retVal;</div><div class="line"></div><div class="line">    <span class="comment">/* Need to parse the error value for Cy_SysPm_LdoSetVoltage and </span></div><div class="line"><span class="comment">    *  Cy_SysPm_BuckSetVoltage1 functions. The functions can return two types</span></div><div class="line"><span class="comment">    *  of error:</span></div><div class="line"><span class="comment">    *  CY_SYSPM_INVALID_STATE - The operation cannot be executed, because  </span></div><div class="line"><span class="comment">    *  the application runs in protection context higher than zero (PC &gt; 0),  </span></div><div class="line"><span class="comment">    *  or device revision does not support modifying registers via syscall.</span></div><div class="line"><span class="comment">    *  CY_SYSPM_CANCELED - The operation was canceled, and you need to </span></div><div class="line"><span class="comment">    *  call the function again to successfully finish the operation. </span></div><div class="line"><span class="comment">    */</span> </div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__functions__ldo.html#ga9902e6f64bd939f234fe15612d0f1da8">Cy_SysPm_LdoIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__data__enumerates.html#ggaef8ba4a0ee827abcaaf62f950e69496eaee236d7a70299bdd4bb9e9d74d205254">CY_SYSPM_LDO_VOLTAGE_ULP</a> == Cy_SysPm_LdoGetVoltage())</div><div class="line">        {</div><div class="line">            uint32_t triesToSetVoltage = 5u;</div><div class="line">            </div><div class="line">            <span class="keywordflow">do</span></div><div class="line">            {</div><div class="line">                <span class="comment">/* Call the function until the operation is finished */</span></div><div class="line">                retVal = <a class="code" href="group__group__syspm__functions__ldo.html#gaa583169f7b72095e98650fc30dfbcb24">Cy_SysPm_LdoSetVoltage</a>(<a class="code" href="group__group__syspm__data__enumerates.html#ggaef8ba4a0ee827abcaaf62f950e69496eafec1860878ca84cdfd201632a1d29689">CY_SYSPM_LDO_VOLTAGE_1_1V</a>);</div><div class="line">                --triesToSetVoltage;</div><div class="line">            } <span class="keywordflow">while</span> ((<a class="code" href="group__group__syspm__data__enumerates.html#gga601b1cb722cb091133caf33d8ab235caaf00d22f1ee891a8a56f8bbf58132e775">CY_SYSPM_SUCCESS</a> != retVal) &amp;&amp; (triesToSetVoltage != 0));</div><div class="line">            </div><div class="line">            <span class="keywordflow">if</span> (0U == triesToSetVoltage)</div><div class="line">            {</div><div class="line">                <span class="comment">/* The operation was not performed */</span></div><div class="line">            }</div><div class="line">            </div><div class="line">            <span class="comment">/* Call Cy_SysLib_SetWaitStates(false, clkMHz);</span></div><div class="line"><span class="comment">             * where clkMHz is the core frequency in MHz</span></div><div class="line"><span class="comment">             */</span></div><div class="line">        }</div><div class="line">    }</div><div class="line">    <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__functions__buck.html#ga41a4137be1cb55334e43695b2121a2ea">Cy_SysPm_BuckIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__data__enumerates.html#gga3917bcfb5a7b4151ec1b0fcd95c37d5aa0009b3f9bef2d360c1b221cd8c801650">CY_SYSPM_BUCK_OUT1_VOLTAGE_ULP</a> == <a class="code" href="group__group__syspm__functions__buck.html#gaff41cf4c20919517afb8adfd818d1940">Cy_SysPm_BuckGetVoltage1</a>())</div><div class="line">        {</div><div class="line">            uint32_t triesToSetVoltage = 5u;</div><div class="line">            </div><div class="line">            <span class="keywordflow">do</span></div><div class="line">            {</div><div class="line">                <span class="comment">/* Call the function until the operation is finished */</span></div><div class="line">                retVal = <a class="code" href="group__group__syspm__functions__buck.html#gabcdba9193b78620e0e6481f068093376">Cy_SysPm_BuckSetVoltage1</a>(<a class="code" href="group__group__syspm__data__enumerates.html#gga3917bcfb5a7b4151ec1b0fcd95c37d5aa6de6ed7b114c74828ab1201648f384fb">CY_SYSPM_BUCK_OUT1_VOLTAGE_1_1V</a>);</div><div class="line">                --triesToSetVoltage;</div><div class="line">            } <span class="keywordflow">while</span> ((<a class="code" href="group__group__syspm__data__enumerates.html#gga601b1cb722cb091133caf33d8ab235caaf00d22f1ee891a8a56f8bbf58132e775">CY_SYSPM_SUCCESS</a> != retVal) &amp;&amp; (triesToSetVoltage != 0));</div><div class="line">            </div><div class="line">            <span class="keywordflow">if</span> (0U == triesToSetVoltage)</div><div class="line">            {</div><div class="line">                <span class="comment">/* The operation was not performed */</span></div><div class="line">            }</div><div class="line"></div><div class="line">            <span class="comment">/* Call Cy_SysLib_SetWaitStates(false, clkMHz);</span></div><div class="line"><span class="comment">             * where clkMHz is the CPU frequency in MHz</span></div><div class="line"><span class="comment">             */</span></div><div class="line">        }</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga3134f6b474d6bba15825971923349372"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3134f6b474d6bba15825971923349372">&#9670;&nbsp;</a></span>Cy_SysPm_LdoSetMode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_SysPm_LdoSetMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gab23a08d99fea934c12e01f877c26dd80">cy_en_syspm_ldo_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the core LDO regulator operating mode to one of three modes. </p>
<p>Disabled - turns off the LDO regulator and should be selected only after the Buck regulator is operating. Normal mode configures the LDO for operation at the maximum output current limit. Minimal current mode optimizes the LDO at a reduced output current limit. Specific device current limits can be found in the device datasheet.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mode</td><td>The desired LDO regulator operating mode. See <a class="el" href="group__group__syspm__data__enumerates.html#gab23a08d99fea934c12e01f877c26dd80">cy_en_syspm_ldo_mode_t</a> mode</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>CY_SYSPM_SUCCESS - Requested regulator current mode was set</li>
<li>CY_SYSPM_CANCELED - The power circuits were not ready to enter into minimum current mode. You should try to call the function again</li>
<li>CY_SYSPM_TIMEOUT - Timeout occurred because of active reference was not ready to enter into the normal regulator current mode</li>
<li>CY_SYSPM_FAIL - incorrect mode value was passed For the PSoC 64 devices there are possible situations when function returns the PRA error status code. This is because for PSoC 64 devices the function uses the PRA driver to change the protected registers. Refer to <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> for more details.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Side Effects</dt><dd>For PSoC 64 series devices CY_SYSPM_LDO_MODE_DISABLED mode is not supported. Use <a class="el" href="group__group__syspm__functions__buck.html#ga88ac4d8e9a2ad9fdff09eb5d94de9a12">Cy_SysPm_BuckEnable()</a> instead. </dd></dl>

</div>
</div>
<a id="ga5d545d75711f6aa1889ec5faa871d9fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d545d75711f6aa1889ec5faa871d9fb">&#9670;&nbsp;</a></span>Cy_SysPm_LdoGetMode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#gab23a08d99fea934c12e01f877c26dd80">cy_en_syspm_ldo_mode_t</a> Cy_SysPm_LdoGetMode </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current core LDO regulator operating mode. </p>
<dl class="section return"><dt>Returns</dt><dd>The LDO regulator operating mode. See <a class="el" href="group__group__syspm__data__enumerates.html#gab23a08d99fea934c12e01f877c26dd80">cy_en_syspm_ldo_mode_t</a> mode </dd></dl>

</div>
</div>
<a id="ga9902e6f64bd939f234fe15612d0f1da8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9902e6f64bd939f234fe15612d0f1da8">&#9670;&nbsp;</a></span>Cy_SysPm_LdoIsEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_LdoIsEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the current status of the core LDO regulator. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>True means the LDO is enabled.</li>
<li>False means it is disabled.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to increase the core supply voltage  */</span></div><div class="line">    <a class="code" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> retVal;</div><div class="line"></div><div class="line">    <span class="comment">/* Need to parse the error value for Cy_SysPm_LdoSetVoltage and </span></div><div class="line"><span class="comment">    *  Cy_SysPm_BuckSetVoltage1 functions. The functions can return two types</span></div><div class="line"><span class="comment">    *  of error:</span></div><div class="line"><span class="comment">    *  CY_SYSPM_INVALID_STATE - The operation cannot be executed, because  </span></div><div class="line"><span class="comment">    *  the application runs in protection context higher than zero (PC &gt; 0),  </span></div><div class="line"><span class="comment">    *  or device revision does not support modifying registers via syscall.</span></div><div class="line"><span class="comment">    *  CY_SYSPM_CANCELED - The operation was canceled, and you need to </span></div><div class="line"><span class="comment">    *  call the function again to successfully finish the operation. </span></div><div class="line"><span class="comment">    */</span> </div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__functions__ldo.html#ga9902e6f64bd939f234fe15612d0f1da8">Cy_SysPm_LdoIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__data__enumerates.html#ggaef8ba4a0ee827abcaaf62f950e69496eaee236d7a70299bdd4bb9e9d74d205254">CY_SYSPM_LDO_VOLTAGE_ULP</a> == Cy_SysPm_LdoGetVoltage())</div><div class="line">        {</div><div class="line">            uint32_t triesToSetVoltage = 5u;</div><div class="line">            </div><div class="line">            <span class="keywordflow">do</span></div><div class="line">            {</div><div class="line">                <span class="comment">/* Call the function until the operation is finished */</span></div><div class="line">                retVal = <a class="code" href="group__group__syspm__functions__ldo.html#gaa583169f7b72095e98650fc30dfbcb24">Cy_SysPm_LdoSetVoltage</a>(<a class="code" href="group__group__syspm__data__enumerates.html#ggaef8ba4a0ee827abcaaf62f950e69496eafec1860878ca84cdfd201632a1d29689">CY_SYSPM_LDO_VOLTAGE_1_1V</a>);</div><div class="line">                --triesToSetVoltage;</div><div class="line">            } <span class="keywordflow">while</span> ((<a class="code" href="group__group__syspm__data__enumerates.html#gga601b1cb722cb091133caf33d8ab235caaf00d22f1ee891a8a56f8bbf58132e775">CY_SYSPM_SUCCESS</a> != retVal) &amp;&amp; (triesToSetVoltage != 0));</div><div class="line">            </div><div class="line">            <span class="keywordflow">if</span> (0U == triesToSetVoltage)</div><div class="line">            {</div><div class="line">                <span class="comment">/* The operation was not performed */</span></div><div class="line">            }</div><div class="line">            </div><div class="line">            <span class="comment">/* Call Cy_SysLib_SetWaitStates(false, clkMHz);</span></div><div class="line"><span class="comment">             * where clkMHz is the core frequency in MHz</span></div><div class="line"><span class="comment">             */</span></div><div class="line">        }</div><div class="line">    }</div><div class="line">    <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__functions__buck.html#ga41a4137be1cb55334e43695b2121a2ea">Cy_SysPm_BuckIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <span class="keywordflow">if</span> (<a class="code" href="group__group__syspm__data__enumerates.html#gga3917bcfb5a7b4151ec1b0fcd95c37d5aa0009b3f9bef2d360c1b221cd8c801650">CY_SYSPM_BUCK_OUT1_VOLTAGE_ULP</a> == <a class="code" href="group__group__syspm__functions__buck.html#gaff41cf4c20919517afb8adfd818d1940">Cy_SysPm_BuckGetVoltage1</a>())</div><div class="line">        {</div><div class="line">            uint32_t triesToSetVoltage = 5u;</div><div class="line">            </div><div class="line">            <span class="keywordflow">do</span></div><div class="line">            {</div><div class="line">                <span class="comment">/* Call the function until the operation is finished */</span></div><div class="line">                retVal = <a class="code" href="group__group__syspm__functions__buck.html#gabcdba9193b78620e0e6481f068093376">Cy_SysPm_BuckSetVoltage1</a>(<a class="code" href="group__group__syspm__data__enumerates.html#gga3917bcfb5a7b4151ec1b0fcd95c37d5aa6de6ed7b114c74828ab1201648f384fb">CY_SYSPM_BUCK_OUT1_VOLTAGE_1_1V</a>);</div><div class="line">                --triesToSetVoltage;</div><div class="line">            } <span class="keywordflow">while</span> ((<a class="code" href="group__group__syspm__data__enumerates.html#gga601b1cb722cb091133caf33d8ab235caaf00d22f1ee891a8a56f8bbf58132e775">CY_SYSPM_SUCCESS</a> != retVal) &amp;&amp; (triesToSetVoltage != 0));</div><div class="line">            </div><div class="line">            <span class="keywordflow">if</span> (0U == triesToSetVoltage)</div><div class="line">            {</div><div class="line">                <span class="comment">/* The operation was not performed */</span></div><div class="line">            }</div><div class="line"></div><div class="line">            <span class="comment">/* Call Cy_SysLib_SetWaitStates(false, clkMHz);</span></div><div class="line"><span class="comment">             * where clkMHz is the CPU frequency in MHz</span></div><div class="line"><span class="comment">             */</span></div><div class="line">        }</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga00ae492b61f731af99f3f378e640e82c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga00ae492b61f731af99f3f378e640e82c">&#9670;&nbsp;</a></span>Cy_SysPm_SdrConfigure()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_SdrConfigure </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a>&#160;</td>
          <td class="paramname"><em>sdr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__syspm__sdr__params__t.html">cy_stc_syspm_sdr_params_t</a> *&#160;</td>
          <td class="paramname"><em>config</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the SDR(Step Down Regulator) </p>
<dl class="section note"><dt>Note</dt><dd>The CBUCK voltage selection must be 60mV higher than the SDR output or the regulator output may bypass.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sdr</td><td>CY_SYSPM_SDR_0 - for SDR0 CY_SYSPM_SDR_1 - for SDR1</td></tr>
    <tr><td class="paramname">config</td><td>Structure containing the config parameters, <a class="el" href="structcy__stc__syspm__sdr__params__t.html">cy_stc_syspm_sdr_params_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Maintain below conditions when switching th voltages High to Low voltage &ndash;&gt; Set TRIM's first , Set Voltage next Low to High voltage &ndash;&gt; Set Voltage first , Set TRIM's next</dd>
<dd>
This API is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="gadee6863d26fa2d5edf2631e265890aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadee6863d26fa2d5edf2631e265890aca">&#9670;&nbsp;</a></span>Cy_SysPm_SdrSetVoltage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_SdrSetVoltage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a>&#160;</td>
          <td class="paramname"><em>sdr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga5b3fa93779730eb75af8b267923d68c1">cy_en_syspm_sdr_voltage_t</a>&#160;</td>
          <td class="paramname"><em>voltage</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the SDR(Step Down Regulator) Voltage. </p>
<dl class="section note"><dt>Note</dt><dd>The CBUCK voltage selection must be 60mV higher than the SDR output or the regulator output may bypass.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sdr</td><td>CY_SYSPM_SDR_0 - for SDR0 CY_SYSPM_SDR_1 - for SDR1</td></tr>
    <tr><td class="paramname">voltage</td><td>Pick from <a class="el" href="group__group__syspm__data__enumerates.html#ga5b3fa93779730eb75af8b267923d68c1">cy_en_syspm_sdr_voltage_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Maintain below conditions when switching th voltages High to Low voltage &ndash;&gt; Set TRIM's first , Set Voltage next Low to High voltage &ndash;&gt; Set Voltage first , Set TRIM's next</dd>
<dd>
This API is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="gae44ed9b76b5c3d3362f4c05b981d3811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae44ed9b76b5c3d3362f4c05b981d3811">&#9670;&nbsp;</a></span>Cy_SysPm_SdrGetVoltage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga5b3fa93779730eb75af8b267923d68c1">cy_en_syspm_sdr_voltage_t</a> Cy_SysPm_SdrGetVoltage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a>&#160;</td>
          <td class="paramname"><em>sdr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the SDR(Step Down Regulator) Voltage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sdr</td><td>CY_SYSPM_SDR_0 - for SDR0 CY_SYSPM_SDR_1 - for SDR1</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Gets Voltage enum value of type <a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="gaa3fba12a46b88e6065a29d571d86b9cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa3fba12a46b88e6065a29d571d86b9cd">&#9670;&nbsp;</a></span>Cy_SysPm_SdrEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_SdrEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a>&#160;</td>
          <td class="paramname"><em>sdr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable the SDR(Step Down Regulator) </p>
<dl class="section note"><dt>Note</dt><dd>Applicable for only SDR1, whereas SDR0 is always enabled.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sdr</td><td>CY_SYSPM_SDR_0 - for SDR0 CY_SYSPM_SDR_1 - for SDR1</td></tr>
    <tr><td class="paramname">enable</td><td>true - enable, false - disable</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga674c55d4039bdd8f3edadabc77d8ebea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga674c55d4039bdd8f3edadabc77d8ebea">&#9670;&nbsp;</a></span>Cy_SysPm_IsSdrEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_IsSdrEnabled </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaadd068c13e4c6a2f850492c542b2492b">cy_en_syspm_sdr_t</a>&#160;</td>
          <td class="paramname"><em>sdr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks if SDR(Step Down Regulator) is enabled or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sdr</td><td>CY_SYSPM_SDR_0 - for SDR0 CY_SYSPM_SDR_1 - for SDR1</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if enabled, False if disabled.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="gac91039d9210a0acdf5335cf839680f87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac91039d9210a0acdf5335cf839680f87">&#9670;&nbsp;</a></span>Cy_SysPm_HvLdoConfigure()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_HvLdoConfigure </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__syspm__hvldo__params__t.html">cy_stc_syspm_hvldo_params_t</a> *&#160;</td>
          <td class="paramname"><em>config</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the HVLDO Regulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">config</td><td>Structure containing the config parameters, <a class="el" href="structcy__stc__syspm__hvldo__params__t.html">cy_stc_syspm_hvldo_params_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga75ff19a75ee1a483fa0f5b3c50157cd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75ff19a75ee1a483fa0f5b3c50157cd4">&#9670;&nbsp;</a></span>Cy_SysPm_HvLdoSetVoltage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_HvLdoSetVoltage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga64b1d9370a07008a83b14bcbee4f731c">cy_en_syspm_hvldo_voltage_t</a>&#160;</td>
          <td class="paramname"><em>voltage</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the HVLDO Regulator Voltage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">voltage</td><td>Pick from <a class="el" href="group__group__syspm__data__enumerates.html#ga64b1d9370a07008a83b14bcbee4f731c">cy_en_syspm_hvldo_voltage_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga462f8b51cd933b85d270d64fe00bdafa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga462f8b51cd933b85d270d64fe00bdafa">&#9670;&nbsp;</a></span>Cy_SysPm_HvLdoGetVoltage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga64b1d9370a07008a83b14bcbee4f731c">cy_en_syspm_hvldo_voltage_t</a> Cy_SysPm_HvLdoGetVoltage </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the HVLDO Regulator Voltage. </p>
<dl class="section return"><dt>Returns</dt><dd>Gets Voltage enum value of type <a class="el" href="group__group__syspm__data__enumerates.html#ga64b1d9370a07008a83b14bcbee4f731c">cy_en_syspm_hvldo_voltage_t</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga25bdb2ff02fd26194f094ab7b144eaba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga25bdb2ff02fd26194f094ab7b144eaba">&#9670;&nbsp;</a></span>Cy_SysPm_HvLdoEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_HvLdoEnable </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable the HVLDO Regulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>true - enable, false - disable</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This parameter is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga085d5c511f849d5846338f79c1e7778f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga085d5c511f849d5846338f79c1e7778f">&#9670;&nbsp;</a></span>Cy_SysPm_IsHvLdoEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysPm_IsHvLdoEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks if HVLDO Regulator is enabled or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if enabled, False if disabled.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This parameter is available for CAT1B devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
